/*
 * Copyright 2016-2024 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.springframework.vault.support;

/**
 * Vault unseal status.
 *
 * @author Mark Paluch
 */
public interface VaultUnsealStatus {

	/**
	 * @return total number of existing keyshares.
	 */
	int getSecretShares();

	/**
	 * @return required number of keyshares to unseal Vault.
	 */
	int getSecretThreshold();

	/**
	 * @return {@literal true} if Vault is sealed.
	 */
	boolean isSealed();

	/**
	 * @return number of remaining required keyshares to unseal Vault.
	 */
	int getProgress();

}
